-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
IMessageFilterTable`1.xml
564 lines (512 loc) · 43.3 KB
/
IMessageFilterTable`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
<Type Name="IMessageFilterTable<TFilterData>" FullName="System.ServiceModel.Dispatcher.IMessageFilterTable<TFilterData>">
<TypeSignature Language="C#" Value="public interface IMessageFilterTable<TFilterData> : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.ServiceModel.Dispatcher.MessageFilter,TFilterData>>, System.Collections.Generic.IDictionary<System.ServiceModel.Dispatcher.MessageFilter,TFilterData>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.ServiceModel.Dispatcher.MessageFilter,TFilterData>>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IMessageFilterTable`1<TFilterData> implements class System.Collections.Generic.ICollection`1<valuetype System.Collections.Generic.KeyValuePair`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>>, class System.Collections.Generic.IDictionary`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>, class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>>, class System.Collections.IEnumerable" FrameworkAlternate="net-8.0" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Dispatcher.IMessageFilterTable`1" />
<TypeSignature Language="VB.NET" Value="Public Interface IMessageFilterTable(Of TFilterData)
Implements ICollection(Of KeyValuePair(Of MessageFilter, TFilterData)), IDictionary(Of MessageFilter, TFilterData), IEnumerable(Of KeyValuePair(Of MessageFilter, TFilterData))" />
<TypeSignature Language="F#" Value="type IMessageFilterTable<'FilterData> = interface
 interface IDictionary<MessageFilter, 'FilterData>
 interface ICollection<KeyValuePair<MessageFilter, 'FilterData>>
 interface seq<KeyValuePair<MessageFilter, 'FilterData>>
 interface IEnumerable" />
<TypeSignature Language="C++ CLI" Value="generic <typename TFilterData>
public interface class IMessageFilterTable : System::Collections::Generic::ICollection<System::Collections::Generic::KeyValuePair<System::ServiceModel::Dispatcher::MessageFilter ^, TFilterData>>, System::Collections::Generic::IDictionary<System::ServiceModel::Dispatcher::MessageFilter ^, TFilterData>, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::ServiceModel::Dispatcher::MessageFilter ^, TFilterData>>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IMessageFilterTable`1<TFilterData> implements class System.Collections.Generic.ICollection`1<valuetype System.Collections.Generic.KeyValuePair`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>>, class System.Collections.Generic.IDictionary`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>, class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<class System.ServiceModel.Dispatcher.MessageFilter, !TFilterData>>, class System.Collections.IEnumerable" FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TFilterData" />
</TypeParameters>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.ServiceModel.Dispatcher.MessageFilter,TFilterData>></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IDictionary<System.ServiceModel.Dispatcher.MessageFilter,TFilterData></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.ServiceModel.Dispatcher.MessageFilter,TFilterData>></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<TKey,TValue>></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TFilterData">The type of data associated with each filter in the table.</typeparam>
<summary>An <see langword="interface" /> that defines the contract that a filter table must implement to inspect messages with query criteria derived from one or more filters.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The filter table is a core component of the filter engine. The primary use of the filter engine in Windows Communication Foundation (WCF) is to match application logic to messages by finding all the filters that match a message.
A filter table allows multiple filters to be matched against a single message more efficiently than they can be matched separately. A filter table associates filter data with filters. The table is a collection of key-value pairs, where the key is the <xref:System.ServiceModel.Dispatcher.MessageFilter>, and the value is the associated filter data. Filter data can be any data of the type specified in the generic parameter and can be used to specify what actions to take if a message is matched by a filter in the table.
Filter table entries can be accessed using the <xref:System.Collections.Generic.IDictionary%602> functionality that <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601> inherits.
Note that a filter instance can only be added to a given <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601> once. To add multiple instances of this filter to the same filter table, use a filter constructor to create additional instances.
A filter matches a message when the message satisfies the query criteria of the filter. There are four overloaded matching methods. The data returned is either the filter data or the <xref:System.ServiceModel.Dispatcher.MessageFilter> objects themselves. This data is returned whether multiple matches are allowed or only a single match. The following table shows this information for each overload.
|Method Name|Matches|Data Returned|
|-----------------|-------------|-------------------|
|<xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValue%2A>|Single|`FilterData`|
|<xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A>|Single|<xref:System.ServiceModel.Dispatcher.MessageFilter>|
|<xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValues%2A>|Multiple|`FilterData`|
|<xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilters%2A>|Multiple|<xref:System.ServiceModel.Dispatcher.MessageFilter> objects|
Each method contains two overloads. The difference between the two overloads is that one takes a <xref:System.ServiceModel.Channels.Message> parameter and is not permitted to examine the contents of the body; the other takes a <xref:System.ServiceModel.Channels.MessageBuffer> parameter and can examine any part of the message. If you call a method with the message parameter, and the filter table contains a filter that examines the content of the message body, an exception is thrown. If you are unsure about the filters in a table, call the overload that takes a message buffer.
Message headers are automatically buffered and can be inspected by a filter without being consumed. But if the body is to be inspected by a filter, then the entire message must be buffered because an unbuffered message body is consumed by a query and its contents destroyed.
The following classes implement <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601>:
- <xref:System.ServiceModel.Dispatcher.MessageFilterTable%601>
- <xref:System.ServiceModel.Dispatcher.XPathMessageFilterTable%601>
]]></format>
</remarks>
<threadsafe>Filter tables are thread-safe with respect to matching operations, but are not thread-safe with respect to modification. Threads that access a filter table should be synchronized by the <see cref="T:System.Threading.ReaderWriterLock" /> or similar locking semantic. This lock allows multiple reads of a filter table (for example, a match operation) to run simultaneously, but in order to write to a filter table (for example, adding a filter), a thread must wait for an exclusive lock.
All compilation is done when filters are added to the table. If you create a filter table in advance, and never edit it, locking is not necessary during a match.</threadsafe>
</Docs>
<Members>
<MemberGroup MemberName="GetMatchingFilter">
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Returns a filter from the table whose query criteria are satisfied by a specified message or buffered message.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when a single filter is expected to match the message and the matching filter is required.
Use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A> if the body content does not require examination. Use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A> if the contents of the message body may require examination.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If more than one filter matches the message, a <see cref="T:System.ServiceModel.Dispatcher.MultipleFilterMatchesException" /> must be thrown.</para>
</block>
</Docs>
</MemberGroup>
<Member MemberName="GetMatchingFilter">
<MemberSignature Language="C#" Value="public bool GetMatchingFilter (System.ServiceModel.Channels.Message message, out System.ServiceModel.Dispatcher.MessageFilter filter);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingFilter(class System.ServiceModel.Channels.Message message, [out] class System.ServiceModel.Dispatcher.MessageFilter& filter) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingFilter(System.ServiceModel.Channels.Message,System.ServiceModel.Dispatcher.MessageFilter@)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingFilter (message As Message, ByRef filter As MessageFilter) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingFilter : System.ServiceModel.Channels.Message * MessageFilter -> bool" Usage="iMessageFilterTable.GetMatchingFilter (message, filter)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingFilter(System::ServiceModel::Channels::Message ^ message, [Runtime::InteropServices::Out] System::ServiceModel::Dispatcher::MessageFilter ^ % filter);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
<Parameter Name="filter" Type="System.ServiceModel.Dispatcher.MessageFilter" RefType="out" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.ServiceModel.Channels.Message" /> to test.</param>
<param name="filter">
<see langword="out" /> parameter that stores the filter that is satisfied by the <paramref name="message" />. If no filter was found, the parameter is set to its default value.</param>
<summary>Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified message, and returns that filter in an <see langword="out" /> parameter.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="message" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when a single filter is expected to match the message and the matching filter is required.
If the body of the message must be inspected by a filter in the filter table, use the <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A> version of the method.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If more than one filter matches the message, a <see cref="T:System.ServiceModel.Dispatcher.MultipleFilterMatchesException" /> must be thrown.
This version takes a <see cref="T:System.ServiceModel.Channels.Message" /> and must throw an <see cref="T:System.ServiceModel.Dispatcher.InvalidBodyAccessException" /> if it tries to examine the message body.</para>
</block>
</Docs>
</Member>
<Member MemberName="GetMatchingFilter">
<MemberSignature Language="C#" Value="public bool GetMatchingFilter (System.ServiceModel.Channels.MessageBuffer messageBuffer, out System.ServiceModel.Dispatcher.MessageFilter filter);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingFilter(class System.ServiceModel.Channels.MessageBuffer messageBuffer, [out] class System.ServiceModel.Dispatcher.MessageFilter& filter) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingFilter(System.ServiceModel.Channels.MessageBuffer,System.ServiceModel.Dispatcher.MessageFilter@)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingFilter (messageBuffer As MessageBuffer, ByRef filter As MessageFilter) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingFilter : System.ServiceModel.Channels.MessageBuffer * MessageFilter -> bool" Usage="iMessageFilterTable.GetMatchingFilter (messageBuffer, filter)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingFilter(System::ServiceModel::Channels::MessageBuffer ^ messageBuffer, [Runtime::InteropServices::Out] System::ServiceModel::Dispatcher::MessageFilter ^ % filter);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageBuffer" Type="System.ServiceModel.Channels.MessageBuffer" />
<Parameter Name="filter" Type="System.ServiceModel.Dispatcher.MessageFilter" RefType="out" />
</Parameters>
<Docs>
<param name="messageBuffer">The <see cref="T:System.ServiceModel.Channels.MessageBuffer" /> to test.</param>
<param name="filter">
<see langword="out" /> parameter that stores the filter that is satisfied by the <paramref name="message" />. If no filter was found, the parameter is set to its default value.</param>
<summary>Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified message or buffered message, and returns that filter in an <see langword="out" /> parameter.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="messageBuffer" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when a single filter is expected to match the buffered message, the matching filter must be returned, and the body of the message may have to be inspected.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetMatchingFilters">
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Adds the filters whose query criteria are satisfied by a specified message or buffered message to a collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use one of these methods when more than one filter is expected to match the message and the matching filters are required. Note that the collection that contains the filters is not cleared before the results are added. This allows you to accumulate all matches across multiple filter tables into a single collection.
If the body of the message must be inspected by a filter in the filter table, buffer the message and pass it to the <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilters%2A> method. Otherwise, use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilters%2A>.
The matching <xref:System.ServiceModel.Dispatcher.MessageFilter> objects are stored in the `results` parameter. The filter data can then be recovered from the filter table using these filters as keys with the methods provided by <xref:System.Collections.Generic.IDictionary%602>.
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="GetMatchingFilters">
<MemberSignature Language="C#" Value="public bool GetMatchingFilters (System.ServiceModel.Channels.Message message, System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter> results);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingFilters(class System.ServiceModel.Channels.Message message, class System.Collections.Generic.ICollection`1<class System.ServiceModel.Dispatcher.MessageFilter> results) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingFilters(System.ServiceModel.Channels.Message,System.Collections.Generic.ICollection{System.ServiceModel.Dispatcher.MessageFilter})" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingFilters (message As Message, results As ICollection(Of MessageFilter)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingFilters : System.ServiceModel.Channels.Message * System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter> -> bool" Usage="iMessageFilterTable.GetMatchingFilters (message, results)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingFilters(System::ServiceModel::Channels::Message ^ message, System::Collections::Generic::ICollection<System::ServiceModel::Dispatcher::MessageFilter ^> ^ results);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
<Parameter Name="results" Type="System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter>" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.ServiceModel.Channels.Message" /> to test.</param>
<param name="results">Reference parameter that stores the <see cref="T:System.ServiceModel.Dispatcher.MessageFilter" /> objects that match in <see cref="T:System.Collections.Generic.ICollection`1" /><Filter>.</param>
<summary>Returns a value that indicates whether the match criterion of a filter in the table is satisfied by the specified message, and adds the matching filters to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="message" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when more than one filter is expected to match the message, the matching filters are required, and the body of the message does not have to be inspected.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>This version takes a <see cref="T:System.ServiceModel.Channels.Message" /> and must throw an <see cref="T:System.ServiceModel.Dispatcher.InvalidBodyAccessException" /> if it tries to examine the message body.</para>
</block>
</Docs>
</Member>
<Member MemberName="GetMatchingFilters">
<MemberSignature Language="C#" Value="public bool GetMatchingFilters (System.ServiceModel.Channels.MessageBuffer messageBuffer, System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter> results);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingFilters(class System.ServiceModel.Channels.MessageBuffer messageBuffer, class System.Collections.Generic.ICollection`1<class System.ServiceModel.Dispatcher.MessageFilter> results) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingFilters(System.ServiceModel.Channels.MessageBuffer,System.Collections.Generic.ICollection{System.ServiceModel.Dispatcher.MessageFilter})" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingFilters (messageBuffer As MessageBuffer, results As ICollection(Of MessageFilter)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingFilters : System.ServiceModel.Channels.MessageBuffer * System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter> -> bool" Usage="iMessageFilterTable.GetMatchingFilters (messageBuffer, results)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingFilters(System::ServiceModel::Channels::MessageBuffer ^ messageBuffer, System::Collections::Generic::ICollection<System::ServiceModel::Dispatcher::MessageFilter ^> ^ results);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageBuffer" Type="System.ServiceModel.Channels.MessageBuffer" />
<Parameter Name="results" Type="System.Collections.Generic.ICollection<System.ServiceModel.Dispatcher.MessageFilter>" />
</Parameters>
<Docs>
<param name="messageBuffer">The <see cref="T:System.ServiceModel.Channels.MessageBuffer" /> to test.</param>
<param name="results">Reference parameter that stores the <see cref="T:System.ServiceModel.Dispatcher.MessageFilter" /> objects that match in <see cref="T:System.Collections.Generic.ICollection`1" /><Filter>.</param>
<summary>Returns a value that indicates whether the match criterion of a filter in the table is satisfied by the specified buffered message, and adds the matching filters to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="messageBuffer" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when more than one filter is expected to match the buffered message, the matching filter is required, and the body of the message may have to be inspected.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetMatchingValue">
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Returns a value that indicates whether the match criterion of a filter in the table is satisfied by the specified message or buffered message, and returns the filter data for the filter that matched.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use one of these methods when, at most, one filter is expected to match the message and only the filter data from the matching filter must be recovered. These methods return a boolean that indicates whether a matching filter was found and set the `data` reference parameter to the matching filter data.
Use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A> if the body of the message is not inspected by any of the filters in the filter table.
If the body of the message may be inspected by a filter in the filter table, buffer the message and pass it to the <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingFilter%2A> version of the method.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If more than one filter matches the message, a <see cref="T:System.ServiceModel.Dispatcher.MultipleFilterMatchesException" /> must be thrown.</para>
</block>
</Docs>
</MemberGroup>
<Member MemberName="GetMatchingValue">
<MemberSignature Language="C#" Value="public bool GetMatchingValue (System.ServiceModel.Channels.Message message, out TFilterData value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingValue(class System.ServiceModel.Channels.Message message, [out] !TFilterData& value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingValue(System.ServiceModel.Channels.Message,`0@)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingValue (message As Message, ByRef value As TFilterData) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingValue : System.ServiceModel.Channels.Message * 'FilterData -> bool" Usage="iMessageFilterTable.GetMatchingValue (message, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingValue(System::ServiceModel::Channels::Message ^ message, [Runtime::InteropServices::Out] TFilterData % value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
<Parameter Name="value" Type="TFilterData" RefType="out" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.ServiceModel.Channels.Message" /> to test.</param>
<param name="value">
<see langword="out" /> parameter that stores the <c>FilterData</c> that matches the <paramref name="message" />.</param>
<summary>Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified message, and adds the matching filter data to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of exactly one filter in the table is satisfied by the message; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when a single filter is expected to match the message and only the filter data from the matching filter must be recovered.
This method expects at most a single matching filter. If more than one filter matches, a <xref:System.ServiceModel.Dispatcher.MultipleFilterMatchesException> must be thrown.
If the body of the message must be inspected by a filter in the filter table, buffer the message using <xref:System.ServiceModel.Channels.Message.CreateBufferedCopy%2A> and pass it to the <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValue%2A> version of the method.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If more than one filter matches the message, a <see cref="T:System.ServiceModel.Dispatcher.MultipleFilterMatchesException" /> must be thrown.
This overload takes a <see cref="T:System.ServiceModel.Channels.Message" /> and must throw an <see cref="T:System.ServiceModel.Dispatcher.InvalidBodyAccessException" /> if it tries to examine the message body.</para>
</block>
</Docs>
</Member>
<Member MemberName="GetMatchingValue">
<MemberSignature Language="C#" Value="public bool GetMatchingValue (System.ServiceModel.Channels.MessageBuffer messageBuffer, out TFilterData value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingValue(class System.ServiceModel.Channels.MessageBuffer messageBuffer, [out] !TFilterData& value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingValue(System.ServiceModel.Channels.MessageBuffer,`0@)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingValue (messageBuffer As MessageBuffer, ByRef value As TFilterData) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingValue : System.ServiceModel.Channels.MessageBuffer * 'FilterData -> bool" Usage="iMessageFilterTable.GetMatchingValue (messageBuffer, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingValue(System::ServiceModel::Channels::MessageBuffer ^ messageBuffer, [Runtime::InteropServices::Out] TFilterData % value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageBuffer" Type="System.ServiceModel.Channels.MessageBuffer" />
<Parameter Name="value" Type="TFilterData" RefType="out" />
</Parameters>
<Docs>
<param name="messageBuffer">The <see cref="T:System.ServiceModel.Channels.MessageBuffer" /> to test.</param>
<param name="value">
<see langword="out" /> parameter that stores the <c>FilterData</c> that matches the <paramref name="messageBuffer" />.</param>
<summary>Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified buffered message, and adds the matching filter data to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of exactly one filter in the table is satisfied by the message; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when a single filter is expected to match the buffered message, only the filter data from the matching filter must be recovered, and the body of the message may have to be inspected.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If more than one filter matches the message, a <see cref="T:System.ServiceModel.Dispatcher.MultipleFilterMatchesException" /> must be thrown.</para>
</block>
</Docs>
</Member>
<MemberGroup MemberName="GetMatchingValues">
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Adds the filter data of the filters that match the specified message or buffered message to a collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when more than one filter is expected to match and only the matching filter data is required. These methods return a boolean that indicates whether matching filters were found and put any matching filter data into a collection.
Note that the collection that contains the filter data is not cleared before the results are added. This allows you to accumulate all matches across multiple filter tables into a single collection.
Use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValues%2A> if the contents of the message body do not require examination. Use <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValues%2A> if the contents of the message body requires examination.
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="GetMatchingValues">
<MemberSignature Language="C#" Value="public bool GetMatchingValues (System.ServiceModel.Channels.Message message, System.Collections.Generic.ICollection<TFilterData> results);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingValues(class System.ServiceModel.Channels.Message message, class System.Collections.Generic.ICollection`1<!TFilterData> results) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingValues(System.ServiceModel.Channels.Message,System.Collections.Generic.ICollection{`0})" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingValues (message As Message, results As ICollection(Of TFilterData)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingValues : System.ServiceModel.Channels.Message * System.Collections.Generic.ICollection<'FilterData> -> bool" Usage="iMessageFilterTable.GetMatchingValues (message, results)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingValues(System::ServiceModel::Channels::Message ^ message, System::Collections::Generic::ICollection<TFilterData> ^ results);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
<Parameter Name="results" Type="System.Collections.Generic.ICollection<TFilterData>" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.ServiceModel.Channels.Message" /> to test.</param>
<param name="results">Reference parameter that stores the filter data of the matching filters in a generic collection.</param>
<summary>Returns a value that indicates whether the match criterion of at least one filter in the table is satisfied by the specified message, and adds the <paramref name="FilterData" /> of the matching filters to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="message" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when one or more filters are expected to match the message, only the filter data is required, and the contents of the body of the message are not to be inspected.
The filter data of the matching <xref:System.ServiceModel.Dispatcher.MessageFilter> objects is stored in the `results` parameter.
If the body of the message is inspected by a filter in the filter table, buffer the message and pass it to the <xref:System.ServiceModel.Dispatcher.IMessageFilterTable%601.GetMatchingValues%2A> version of the method.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetMatchingValues">
<MemberSignature Language="C#" Value="public bool GetMatchingValues (System.ServiceModel.Channels.MessageBuffer messageBuffer, System.Collections.Generic.ICollection<TFilterData> results);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool GetMatchingValues(class System.ServiceModel.Channels.MessageBuffer messageBuffer, class System.Collections.Generic.ICollection`1<!TFilterData> results) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.IMessageFilterTable`1.GetMatchingValues(System.ServiceModel.Channels.MessageBuffer,System.Collections.Generic.ICollection{`0})" />
<MemberSignature Language="VB.NET" Value="Public Function GetMatchingValues (messageBuffer As MessageBuffer, results As ICollection(Of TFilterData)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member GetMatchingValues : System.ServiceModel.Channels.MessageBuffer * System.Collections.Generic.ICollection<'FilterData> -> bool" Usage="iMessageFilterTable.GetMatchingValues (messageBuffer, results)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool GetMatchingValues(System::ServiceModel::Channels::MessageBuffer ^ messageBuffer, System::Collections::Generic::ICollection<TFilterData> ^ results);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageBuffer" Type="System.ServiceModel.Channels.MessageBuffer" />
<Parameter Name="results" Type="System.Collections.Generic.ICollection<TFilterData>" />
</Parameters>
<Docs>
<param name="messageBuffer">The <see cref="T:System.ServiceModel.Channels.MessageBuffer" /> to test.</param>
<param name="results">Reference parameter that stores the filter data of the matching filters in a generic <see cref="T:System.Collections.Generic.ICollection`1" /><<c>FilterData</c>>.</param>
<summary>Returns a value that indicates whether the match criterion of at least one filter in the table is satisfied by the specified buffered message, and adds the <paramref name="FilterData" /> of the matching filters to a collection.</summary>
<returns>
<see langword="true" /> if the match criterion of at least one filter in the table is satisfied by <paramref name="messageBuffer" />; <see langword="false" /> if no filter is satisfied.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method when one or more filters are expected to match the buffered message, only the filter data is required, and the body of the message may require inspection.
The filter data of the matching <xref:System.ServiceModel.Dispatcher.MessageFilter> objects is stored in the `results` parameter.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>